API Documentation
CallbackRepository.h
1 // CallbackRepository.h
3 //
5 
6 namespace nkWinUi
7 {
22  using mouseMoveCallback = std::function<bool (Component* caller, int absX, int absY, int relX, int relY, int moveX, int moveY)> ;
32  using mouseClickCallback = std::function<bool (Component* caller, const ClickEventData& eventData)> ;
42  using mouseLeaveCallback = std::function<bool (Component* caller, const nkMaths::Point& absCoords)> ;
43 
54  using keyDownCallback = std::function<bool (Component* caller, KEY_CODE keyCode, bool autoRepeated)> ;
64  using keyUpCallback = std::function<bool (Component* caller, KEY_CODE keyCode)> ;
65 
73  using menuBarCallback = std::function<bool (Component* caller, int index)> ;
74 
81  using buttonClickCallback = std::function<bool (Button* caller)> ;
88  using checkBoxCallback = std::function<bool (CheckBox* caller)> ;
96  using treeSelectionCallback = std::function<bool (TreeView* caller, void* itemData)> ;
103  using listBoxSelectionCallback = std::function<bool (ListBox* caller)> ;
110  using comboSelectionCallback = std::function<bool (ComboBox* caller)> ;
118  using editBoxCharCallback = std::function<bool (EditBox* caller, const CharEventData& key)> ;
126  using editBoxKeyCallback = std::function<bool (EditBox* caller, const KeyEventData& key)> ;
127 
134  using closeCallback = std::function<bool (Component* caller)> ;
141  using resizeCallback = std::function<bool (Component* caller)> ;
142 
151  using contextMenuCreationCallback = std::function<bool (Component* caller, int absX, int absY)> ;
152 }
nkWinUi::mouseLeaveCallback
std::function< bool(Component *caller, const nkMaths::Point &absCoords)> mouseLeaveCallback
Used by components when the mouse leaves their area.
Definition: CallbackRepository.h:42
nkWinUi::ClickEventData
Data holder for a click event.
Definition: ClickEventData.h:12
nkWinUi::CharEventData
Data holder for a char event.
Definition: CharEventData.h:12
nkWinUi::KeyEventData
Data holder for a key event.
Definition: KeyEventData.h:12
nkWinUi::keyUpCallback
std::function< bool(Component *caller, KEY_CODE keyCode)> keyUpCallback
Used by component when a keyboard key is released.
Definition: CallbackRepository.h:64
nkWinUi::TreeView
A graphical tree view window.
Definition: TreeView.h:12
nkWinUi::ListBox
A graphical list box.
Definition: ListBox.h:12
nkWinUi::contextMenuCreationCallback
std::function< bool(Component *caller, int absX, int absY)> contextMenuCreationCallback
Used by components when they need a context menu to be created.
Definition: CallbackRepository.h:151
nkWinUi::closeCallback
std::function< bool(Component *caller)> closeCallback
Used by a component to signal when it's closed.
Definition: CallbackRepository.h:134
nkWinUi::KEY_CODE
KEY_CODE
A key code identifier.
Definition: InputCodes.h:26
nkWinUi::mouseMoveCallback
std::function< bool(Component *caller, int absX, int absY, int relX, int relY, int moveX, int moveY)> mouseMoveCallback
Used by components for a mouse moved event.
Definition: CallbackRepository.h:22
nkWinUi::CheckBox
A graphical check box.
Definition: CheckBox.h:12
nkWinUi::Component
Base class for any graphical component.
Definition: Component.h:12
nkWinUi::buttonClickCallback
std::function< bool(Button *caller)> buttonClickCallback
Used by a nkWinUi::Button to signal it has been clicked.
Definition: CallbackRepository.h:81
nkWinUi::editBoxCharCallback
std::function< bool(EditBox *caller, const CharEventData &key)> editBoxCharCallback
Used by a nkWinUi::EditBox to signal a char has been put inside.
Definition: CallbackRepository.h:118
nkWinUi::ComboBox
A graphical combo box.
Definition: ComboBox.h:12
nkWinUi::menuBarCallback
std::function< bool(Component *caller, int index)> menuBarCallback
Used by a nkWinUi::MenuBar to signal an item has been clicked.
Definition: CallbackRepository.h:73
nkWinUi::resizeCallback
std::function< bool(Component *caller)> resizeCallback
Used by a component upon resize.
Definition: CallbackRepository.h:141
nkWinUi::treeSelectionCallback
std::function< bool(TreeView *caller, void *itemData)> treeSelectionCallback
Used by a nkWinUi::TreeView to signal a selection occurred inside.
Definition: CallbackRepository.h:96
nkWinUi::comboSelectionCallback
std::function< bool(ComboBox *caller)> comboSelectionCallback
Used by a nkWinUi::ComboBox to signal selection changed.
Definition: CallbackRepository.h:110
nkMaths::Point
Represents a 2D Point.
Definition: Point.h:12
nkWinUi::keyDownCallback
std::function< bool(Component *caller, KEY_CODE keyCode, bool autoRepeated)> keyDownCallback
Used by component when a keyboard key is pressed down.
Definition: CallbackRepository.h:54
nkWinUi::Button
A graphical button.
Definition: Button.h:12
nkWinUi::mouseClickCallback
std::function< bool(Component *caller, const ClickEventData &eventData)> mouseClickCallback
Used by components for a mouse click event.
Definition: CallbackRepository.h:32
nkWinUi::listBoxSelectionCallback
std::function< bool(ListBox *caller)> listBoxSelectionCallback
Used by a nkWinUi::ListBox to signal a selection occurred inside.
Definition: CallbackRepository.h:103
nkWinUi::EditBox
A graphical single line edit box.
Definition: EditBox.h:12
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Button.h:7
nkWinUi::editBoxKeyCallback
std::function< bool(EditBox *caller, const KeyEventData &key)> editBoxKeyCallback
Used by a nkWinUi::EditBox to signal a key has been pressed inside.
Definition: CallbackRepository.h:126
nkWinUi::checkBoxCallback
std::function< bool(CheckBox *caller)> checkBoxCallback
Used by a nkWinUi::CheckBox to signal it has been checked / unchecked.
Definition: CallbackRepository.h:88